<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.bukkit.command;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.ArrayList;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.List;<a name="line.4"></a>
<FONT color="green">005</FONT>    <a name="line.5"></a>
<FONT color="green">006</FONT>    /**<a name="line.6"></a>
<FONT color="green">007</FONT>     * Represents a Command, which executes various tasks upon user input<a name="line.7"></a>
<FONT color="green">008</FONT>     */<a name="line.8"></a>
<FONT color="green">009</FONT>    public abstract class Command {<a name="line.9"></a>
<FONT color="green">010</FONT>        private final String name;<a name="line.10"></a>
<FONT color="green">011</FONT>        private String nextLabel;<a name="line.11"></a>
<FONT color="green">012</FONT>        private String label;<a name="line.12"></a>
<FONT color="green">013</FONT>        private List&lt;String&gt; aliases;<a name="line.13"></a>
<FONT color="green">014</FONT>        private List&lt;String&gt; activeAliases;<a name="line.14"></a>
<FONT color="green">015</FONT>        private CommandMap commandMap = null;<a name="line.15"></a>
<FONT color="green">016</FONT>        protected String description = "";<a name="line.16"></a>
<FONT color="green">017</FONT>        protected String usageMessage;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>        protected Command(String name) {<a name="line.19"></a>
<FONT color="green">020</FONT>            this(name, "", "/" + name, new ArrayList&lt;String&gt;());<a name="line.20"></a>
<FONT color="green">021</FONT>        }<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>        protected Command(String name, String description, String usageMessage, List&lt;String&gt; aliases) {<a name="line.23"></a>
<FONT color="green">024</FONT>            this.name = name;<a name="line.24"></a>
<FONT color="green">025</FONT>            this.nextLabel = name;<a name="line.25"></a>
<FONT color="green">026</FONT>            this.label = name;<a name="line.26"></a>
<FONT color="green">027</FONT>            this.description = description;<a name="line.27"></a>
<FONT color="green">028</FONT>            this.usageMessage = usageMessage;<a name="line.28"></a>
<FONT color="green">029</FONT>            this.aliases = aliases;<a name="line.29"></a>
<FONT color="green">030</FONT>            this.activeAliases = new ArrayList&lt;String&gt;(aliases);<a name="line.30"></a>
<FONT color="green">031</FONT>        }<a name="line.31"></a>
<FONT color="green">032</FONT>    <a name="line.32"></a>
<FONT color="green">033</FONT>        /**<a name="line.33"></a>
<FONT color="green">034</FONT>         * Executes the command, returning its success<a name="line.34"></a>
<FONT color="green">035</FONT>         *<a name="line.35"></a>
<FONT color="green">036</FONT>         * @param sender Source object which is executing this command<a name="line.36"></a>
<FONT color="green">037</FONT>         * @param commandLabel The alias of the command used<a name="line.37"></a>
<FONT color="green">038</FONT>         * @param args All arguments passed to the command, split via ' '<a name="line.38"></a>
<FONT color="green">039</FONT>         * @return true if the command was successful, otherwise false<a name="line.39"></a>
<FONT color="green">040</FONT>         */<a name="line.40"></a>
<FONT color="green">041</FONT>        public abstract boolean execute(CommandSender sender, String commandLabel, String[] args);<a name="line.41"></a>
<FONT color="green">042</FONT>    <a name="line.42"></a>
<FONT color="green">043</FONT>        /**<a name="line.43"></a>
<FONT color="green">044</FONT>         * Returns the name of this command<a name="line.44"></a>
<FONT color="green">045</FONT>         *<a name="line.45"></a>
<FONT color="green">046</FONT>         * @return Name of this command<a name="line.46"></a>
<FONT color="green">047</FONT>         */<a name="line.47"></a>
<FONT color="green">048</FONT>        public String getName() {<a name="line.48"></a>
<FONT color="green">049</FONT>            return name;<a name="line.49"></a>
<FONT color="green">050</FONT>        }<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>        /**<a name="line.52"></a>
<FONT color="green">053</FONT>         * Returns the current lable for this command<a name="line.53"></a>
<FONT color="green">054</FONT>         *<a name="line.54"></a>
<FONT color="green">055</FONT>         * @return Label of this command or null if not registered<a name="line.55"></a>
<FONT color="green">056</FONT>         */<a name="line.56"></a>
<FONT color="green">057</FONT>        public String getLabel() {<a name="line.57"></a>
<FONT color="green">058</FONT>            return label;<a name="line.58"></a>
<FONT color="green">059</FONT>        }<a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>        /**<a name="line.61"></a>
<FONT color="green">062</FONT>         * Sets the label of this command<a name="line.62"></a>
<FONT color="green">063</FONT>         * If the command is currently registered the label change will only take effect after<a name="line.63"></a>
<FONT color="green">064</FONT>         * its been reregistered e.g. after a /reload<a name="line.64"></a>
<FONT color="green">065</FONT>         *<a name="line.65"></a>
<FONT color="green">066</FONT>         * @return returns true if the name change happened instantly or false if it was scheduled for reregistration<a name="line.66"></a>
<FONT color="green">067</FONT>         */<a name="line.67"></a>
<FONT color="green">068</FONT>        public boolean setLabel(String name) {<a name="line.68"></a>
<FONT color="green">069</FONT>            this.nextLabel = name;<a name="line.69"></a>
<FONT color="green">070</FONT>            if (!isRegistered()) {<a name="line.70"></a>
<FONT color="green">071</FONT>                this.label = name;<a name="line.71"></a>
<FONT color="green">072</FONT>                return true;<a name="line.72"></a>
<FONT color="green">073</FONT>            }<a name="line.73"></a>
<FONT color="green">074</FONT>            return false;<a name="line.74"></a>
<FONT color="green">075</FONT>        }<a name="line.75"></a>
<FONT color="green">076</FONT>    <a name="line.76"></a>
<FONT color="green">077</FONT>        /**<a name="line.77"></a>
<FONT color="green">078</FONT>         * Registers this command to a CommandMap<a name="line.78"></a>
<FONT color="green">079</FONT>         * Once called it only allows changes the registered CommandMap<a name="line.79"></a>
<FONT color="green">080</FONT>         *<a name="line.80"></a>
<FONT color="green">081</FONT>         * @param commandMap the CommandMap to register this command to<a name="line.81"></a>
<FONT color="green">082</FONT>         * @return true if the registration was successful (the current registered CommandMap was the passed CommandMap or null) false otherwise<a name="line.82"></a>
<FONT color="green">083</FONT>         */<a name="line.83"></a>
<FONT color="green">084</FONT>        public boolean register(CommandMap commandMap) {<a name="line.84"></a>
<FONT color="green">085</FONT>            if (allowChangesFrom(commandMap)) {<a name="line.85"></a>
<FONT color="green">086</FONT>                this.commandMap = commandMap;<a name="line.86"></a>
<FONT color="green">087</FONT>                return true;<a name="line.87"></a>
<FONT color="green">088</FONT>            }<a name="line.88"></a>
<FONT color="green">089</FONT>    <a name="line.89"></a>
<FONT color="green">090</FONT>            return false;<a name="line.90"></a>
<FONT color="green">091</FONT>        }<a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>        /**<a name="line.93"></a>
<FONT color="green">094</FONT>         * Unregisters this command from the passed CommandMap applying any outstanding changes<a name="line.94"></a>
<FONT color="green">095</FONT>         *<a name="line.95"></a>
<FONT color="green">096</FONT>         * @param commandMap the CommandMap to unregister<a name="line.96"></a>
<FONT color="green">097</FONT>         * @return true if the unregistration was successfull (the current registered CommandMap was the passed CommandMap or null) false otherwise<a name="line.97"></a>
<FONT color="green">098</FONT>         */<a name="line.98"></a>
<FONT color="green">099</FONT>        public boolean unregister(CommandMap commandMap) {<a name="line.99"></a>
<FONT color="green">100</FONT>            if (allowChangesFrom(commandMap)) {<a name="line.100"></a>
<FONT color="green">101</FONT>                this.commandMap = null;<a name="line.101"></a>
<FONT color="green">102</FONT>                this.activeAliases = new ArrayList&lt;String&gt;(this.aliases);<a name="line.102"></a>
<FONT color="green">103</FONT>                this.label = this.nextLabel;<a name="line.103"></a>
<FONT color="green">104</FONT>                return true;<a name="line.104"></a>
<FONT color="green">105</FONT>            }<a name="line.105"></a>
<FONT color="green">106</FONT>    <a name="line.106"></a>
<FONT color="green">107</FONT>            return false;<a name="line.107"></a>
<FONT color="green">108</FONT>        }<a name="line.108"></a>
<FONT color="green">109</FONT>    <a name="line.109"></a>
<FONT color="green">110</FONT>    <a name="line.110"></a>
<FONT color="green">111</FONT>        private boolean allowChangesFrom(CommandMap commandMap) {<a name="line.111"></a>
<FONT color="green">112</FONT>            return (null == this.commandMap || this.commandMap == commandMap);<a name="line.112"></a>
<FONT color="green">113</FONT>        }<a name="line.113"></a>
<FONT color="green">114</FONT>    <a name="line.114"></a>
<FONT color="green">115</FONT>        /**<a name="line.115"></a>
<FONT color="green">116</FONT>         * Returns the current registered state of this command<a name="line.116"></a>
<FONT color="green">117</FONT>         *<a name="line.117"></a>
<FONT color="green">118</FONT>         * @return true if this command is currently registered false otherwise<a name="line.118"></a>
<FONT color="green">119</FONT>         */<a name="line.119"></a>
<FONT color="green">120</FONT>        public boolean isRegistered() {<a name="line.120"></a>
<FONT color="green">121</FONT>            return (null != this.commandMap);<a name="line.121"></a>
<FONT color="green">122</FONT>        }<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>        /**<a name="line.124"></a>
<FONT color="green">125</FONT>         * Returns a list of active aliases of this command<a name="line.125"></a>
<FONT color="green">126</FONT>         *<a name="line.126"></a>
<FONT color="green">127</FONT>         * @return List of aliases<a name="line.127"></a>
<FONT color="green">128</FONT>         */<a name="line.128"></a>
<FONT color="green">129</FONT>        public List&lt;String&gt; getAliases() {<a name="line.129"></a>
<FONT color="green">130</FONT>            return activeAliases;<a name="line.130"></a>
<FONT color="green">131</FONT>        }<a name="line.131"></a>
<FONT color="green">132</FONT>    <a name="line.132"></a>
<FONT color="green">133</FONT>        /**<a name="line.133"></a>
<FONT color="green">134</FONT>         * Gets a brief description of this command<a name="line.134"></a>
<FONT color="green">135</FONT>         *<a name="line.135"></a>
<FONT color="green">136</FONT>         * @return Description of this command<a name="line.136"></a>
<FONT color="green">137</FONT>         */<a name="line.137"></a>
<FONT color="green">138</FONT>        public String getDescription() {<a name="line.138"></a>
<FONT color="green">139</FONT>            return description;<a name="line.139"></a>
<FONT color="green">140</FONT>        }<a name="line.140"></a>
<FONT color="green">141</FONT>    <a name="line.141"></a>
<FONT color="green">142</FONT>        /**<a name="line.142"></a>
<FONT color="green">143</FONT>         * Gets an example usage of this command<a name="line.143"></a>
<FONT color="green">144</FONT>         *<a name="line.144"></a>
<FONT color="green">145</FONT>         * @return One or more example usages<a name="line.145"></a>
<FONT color="green">146</FONT>         */<a name="line.146"></a>
<FONT color="green">147</FONT>        public String getUsage() {<a name="line.147"></a>
<FONT color="green">148</FONT>            return usageMessage;<a name="line.148"></a>
<FONT color="green">149</FONT>        }<a name="line.149"></a>
<FONT color="green">150</FONT>    <a name="line.150"></a>
<FONT color="green">151</FONT>        /**<a name="line.151"></a>
<FONT color="green">152</FONT>         * Sets the list of aliases to request on registration for this command<a name="line.152"></a>
<FONT color="green">153</FONT>         *<a name="line.153"></a>
<FONT color="green">154</FONT>         * @param aliases Aliases to register to this command<a name="line.154"></a>
<FONT color="green">155</FONT>         * @return This command object, for linking<a name="line.155"></a>
<FONT color="green">156</FONT>         */<a name="line.156"></a>
<FONT color="green">157</FONT>        public Command setAliases(List&lt;String&gt; aliases) {<a name="line.157"></a>
<FONT color="green">158</FONT>            this.aliases = aliases;<a name="line.158"></a>
<FONT color="green">159</FONT>            if (!isRegistered()) {<a name="line.159"></a>
<FONT color="green">160</FONT>                this.activeAliases = new ArrayList&lt;String&gt;(aliases);<a name="line.160"></a>
<FONT color="green">161</FONT>            }<a name="line.161"></a>
<FONT color="green">162</FONT>            return this;<a name="line.162"></a>
<FONT color="green">163</FONT>        }<a name="line.163"></a>
<FONT color="green">164</FONT>    <a name="line.164"></a>
<FONT color="green">165</FONT>        /**<a name="line.165"></a>
<FONT color="green">166</FONT>         * Sets a brief description of this command<a name="line.166"></a>
<FONT color="green">167</FONT>         *<a name="line.167"></a>
<FONT color="green">168</FONT>         * @param description New command description<a name="line.168"></a>
<FONT color="green">169</FONT>         * @return This command object, for linking<a name="line.169"></a>
<FONT color="green">170</FONT>         */<a name="line.170"></a>
<FONT color="green">171</FONT>        public Command setDescription(String description) {<a name="line.171"></a>
<FONT color="green">172</FONT>            this.description = description;<a name="line.172"></a>
<FONT color="green">173</FONT>            return this;<a name="line.173"></a>
<FONT color="green">174</FONT>        }<a name="line.174"></a>
<FONT color="green">175</FONT>    <a name="line.175"></a>
<FONT color="green">176</FONT>        /**<a name="line.176"></a>
<FONT color="green">177</FONT>         * Sets the example usage of this command<a name="line.177"></a>
<FONT color="green">178</FONT>         *<a name="line.178"></a>
<FONT color="green">179</FONT>         * @param usage New example usage<a name="line.179"></a>
<FONT color="green">180</FONT>         * @return This command object, for linking<a name="line.180"></a>
<FONT color="green">181</FONT>         */<a name="line.181"></a>
<FONT color="green">182</FONT>        public Command setUsage(String usage) {<a name="line.182"></a>
<FONT color="green">183</FONT>            this.usageMessage = usage;<a name="line.183"></a>
<FONT color="green">184</FONT>            return this;<a name="line.184"></a>
<FONT color="green">185</FONT>        }<a name="line.185"></a>
<FONT color="green">186</FONT>    }<a name="line.186"></a>




























































</PRE>
</BODY>
</HTML>
